/*
 * JSF Toolkit Component Framework
 * Copyright (C) 2007 Noah Sloan <iamnoah A-T gmail D0T com>
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 */
package com.jsftoolkit.utils;

import java.io.IOException;

/**
 * Interface for managed beans that process class path resources before serving
 * them. e.g. you might look for occurrences of variables and replace them with
 * their values.
 * 
 * @author noah
 * 
 */
public interface ResourceFilter {

	/**
	 * Key for the parameter that specifies the classpath resource to load.
	 */
	String RESOURCE_KEY = "resource";

	/**
	 * Key for the parameter that specifies the encoding of the resource.
	 */
	String CHARSET_KEY = "encoding";

	/**
	 * Key for the parameter that specifies the type of the resource. e.g.
	 * 'text/css'
	 */
	String CONTENT_TYPE_KEY = "contentType";

	/**
	 * Checks the response for {@link #RESOURCE_KEY}, {@link #CHARSET_KEY} and
	 * {@link #CONTENT_TYPE_KEY} and then writes the resource out, possibly
	 * filtering somehow.
	 * 
	 * @throws IOException
	 */
	void writeFilteredResource() throws IOException;

}